com.highdeal.chrono.hci

Class ChronologyModel

java.lang.Object

com.highdeal.chrono.hci.ChronologyModel

All Implemented Interfaces:

XMLMarshallable

public class ChronologyModel
extends Object
implements XMLMarshallable

This Java class defines a chronology that includes a list of period objects.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="chronology">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="period" minOccurs="0" maxOccurs="unbounded"/>
     </xs:sequence>
   </xs:complexType>
 </xs:element>

Constructor Summary

Constructors

Constructor and Description
ChronologyModel() Constructs an empty ChronologyModel

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String cData) Adds character data to the content element.
void	addChild(String name, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
XMLMarshallable	get(Date d) Returns the valid element at the specified date, or null if there is no valid element.
PeriodObjectModel	getPeriod(Date d) Returns the valid period at the specified date, or null if there is no valid period.
Vector<PeriodObjectModel>	getPeriods() Provides the list of the periods in this chronology
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChronologyModel

public ChronologyModel()

Constructs an empty ChronologyModel

Method Detail

get

public XMLMarshallable get(Date d)

Returns the valid element at the specified date, or null if there is no valid element.

Parameters:

d - The date for which a valid element is to be retrieved

Returns:

The element valid at the specified date, or null if no such element exists

getPeriod

public PeriodObjectModel getPeriod(Date d)

Returns the valid period at the specified date, or null if there is no valid period.

Parameters:

d - The date for which a valid period is to be retrieved

Returns:

The period valid at the specified date, or null if no such element exists

getPeriods

public Vector<PeriodObjectModel> getPeriods()

Provides the list of the periods in this chronology

Returns:

The list of the periods included in this chronology

See Also:

PeriodObjectModel

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XML attributes of the current element

addChild

public void addChild(String name,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Specified by:

addChild in interface XMLMarshallable

Parameters:

name - The name of tag for the child

child - The child to be added

addCharacterData

public void addCharacterData(String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

cData - The character data to be added

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XML output to marshal the object into